Various improvements to the atuin import page
#111
Conversation
waldyrious
changed the title
atuin import page
|
Note/suggestion for maintainers: items 1 and 2 above perhaps indicate that the docs contents should probably live inside Atuin's main repository, to reduce the likelihood of the docs getting out of sync with the code. |
|
@ellie apologies for the ping, but just making sure this doesn't get stale by lack of action on my part 😅 By the way, the fact that the main repository is considerably more active than this one (the two PRs I submitted to it were merged pretty quickly, despite having been created around the same time as this one) is yet another point reinforcing my suggestion in the previous comment, of moving the docs to the main repo :) let me know if that's something y'all would consider! |
|
Recreated as atuinsh/atuin#3062, following the migration of the docs from this repo to the main one in #112 + atuinsh/atuin#3018 (which also addresses the suggestion in my previous comment above! 😃). |
Recreation of PR atuinsh/docs#111, after the migration of the docs to this repo (#3018). Copying the description from that PR, for convenience: This PR implements a few improvements to the import doc page. 1. **Fix name of `zsh-hist-db` and `xonsh-sqlite` subcommands** The `atuin import` subcommands `zsh-hist-db` and `xonsh-sqlite` were incorrectly documented as `zsh_histdb` and `xonsh_sqlite`, respectively. This is likely due to the actual modules that implement the import functionality being indeed named `zsh_histdb` and `xonsh_sqlite` (see [here](https://github.com/atuinsh/atuin/blob/v18.10.0/crates/atuin/src/command/client/import.rs#L14) and [here](https://github.com/atuinsh/atuin/blob/v18.10.0/crates/atuin-client/src/import/mod.rs#L19-L21)), but for the end-user, that results in documentation that's confusing at best, and error-inducing at worst. Fixes issue [#2533](#2533). 2. **Document the `powershell` and `replxx` import subcommands** These importers were introduced in PRs [#2864](#2864) and [#2024](#2024), respectively, but the documentation was not updated to account for them. 3. **Fix alphabetic sorting of sections** Move the `nu-hist-db` and `zsh-hist-db` sections to be after `nu` and `zsh`, respectively. This is more intuitive, and matches the existing sort used for the `xonsh` / `xonsh-sqlite` sections. 4. **Minor whitespace correction** Fix line wrapping in the `resh` section ~~and remove trailing whitespace in the `nu*` sections.~~ <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing Fixes #2533.
1 participant
This PR implements a few improvements to the import doc page.
Fix name of
zsh-hist-dbandxonsh-sqlitesubcommandsThe
atuin importsubcommandszsh-hist-dbandxonsh-sqlitewere incorrectly documented as
zsh_histdbandxonsh_sqlite, respectively.This is likely due to the actual modules that implement the import functionality
being indeed named
zsh_histdbandxonsh_sqlite(see here and here),but for the end-user, that results in documentation that's confusing at best,
and error-inducing at worst.
Fixes issue atuinsh/atuin#2533.
Document the
powershellandreplxximport subcommandsThese importers were introduced in PRs atuinsh/atuin#2864 and atuinsh/atuin#2024, respectively,
but the documentation was not updated to account for them.
Fix alphabetic sorting of sections
Move the
nu-hist-dbandzsh-hist-dbsections to be afternuandzsh, respectively.This is more intuitive, and matches the existing sort used for the
xonsh/xonsh-sqlitesections.Minor whitespace corrections
Fix line wrapping in the
reshsection,and remove trailing whitespace in the
nu*sections.